.. include:: deprecation-notice.rst

.. _bonsai_installation:

Installation
===============================
**Bonsai.ONIX** is a `Bonsai <https://bonsai-rx.org/>`__ package for ONIX
hardware and can be installed using its package manager.

#. First you will need to `install Bonsai <https://bonsai-rx.org/docs/articles/installation.html>`__

#. Open Bonsai. When you are greeted by the start menu, click "Manage
   Packages."

   .. image:: /_static/bonsai/splash-select-package-manager.png
       :alt: Bonsai start menu with "Manage Packages" highlighted.
       :align: center

#. Set the package source to "Bonsai Community".

   .. image:: /_static/bonsai/package-manager-community-packages.png
       :alt: Bonsai package manager with community packages selected as
             package source
       :align: center

#. Search for "ONIX" and install. Installing **Bonsai.ONIX.Design** will
   install both the base **Bonsai.ONIX** package and its visualization tools.

   .. tip:: It is recommended to also install **Bonsai.ONIX.Design** because
       it provides a substantial set of data visualization and graphical hardware
       configuration elements.

   .. image:: /_static/bonsai/package-manager-search-onix.png
        :alt: Bonsai package manager with ONIX in the search bar
        :align: left